Home Explore Help
Register Sign In
jamesperet
/
rails_website_template
Watch 1
Star 0
Fork 0

Browse Source
Updated readme file

jamesperet 9 years ago
parent
e91a2d4857
commit
4f010fa977
2 changed files with 30 additions and 18 deletions
Show Diff Stats
  1. 1 1
      app/mailers/user_mailer.rb
  2. 29 17
      readme.md

+ 1 - 1
app/mailers/user_mailer.rb
View File 

@@ -7,7 +7,7 @@ class UserMailer < ActionMailer::Base
7 7 
          :subject   => ("Welcome to "+ config.website_name),
8 8 
          :from      => config.contact_email,
9 9 
          :from_name => config.website_name,
10 
-         :body      => ("Thanks for registering to our website. ")
10 
+         :body      => "Thanks for registering to our website."
11 11 
   end
12 12
13 13 
   def contact_message(contact_message, to_address)

+ 29 - 17
readme.md
View File 

@@ -12,19 +12,23 @@ A template for creating rails websites that includes the following:
12 12 
 * Contact System
13 13 
 * Maintaince Mode
14 14 
 * Email System (PaperClip + Mandrill)
15 
+* Subscription form with Mailchimp integration
16 
+* Google Analytics
15 17 
 * Tests
16 18
17 
-## Installation
19 
+## Installation and Configurations
18 20
19 21 
 1. Clone the project: ```https://github.com/jamesperet/rails_website_template.git```
20 
-2. Create *postgres* databases for **development** and **test** enviorments.
22 
+2. Create a *postgres* databases for **development** and **test** enviorments.
21 23 
 3. Configure the databases in ```config/database.yml```
22 24 
 4. Run  ```rake db:migrate```
23 
-5. Run  ```rake bootstrap:all```
24 
-6. Start the server: ```rails server -p 3000```
25 
-7. Login as ```admin@website.com``` with the password ```12345678```
25 
+5. Run  ```rake bootstrap:all``` to configure the website and create a admin user
26 
+6. Create the file ```config/application.yml``` with all **env variables**
27 
+7. Set the Google Analytics Tracking code in the file ```app/assets/javascript/google_analytics.js.coffe```
28 
+8. Start the server: ```rails server -p 3000```
29 
+9. Login as ```admin@website.com``` with the password ```12345678```
26 30
27 
-## Heroku Deploy
31 
+## Deploy to Heroku
28 32
29 33 
 1. Create a new heroku app: ```heroku create new-app-name```
30 34 
 2. Run ```figaro heroku:set -e production``` to copy env variables from ```config/application.yml```  and set them in heroku
 
@@ -33,9 +37,25 @@ A template for creating rails websites that includes the following:
33 37 
 5. Migrate the database: ```heroku run rake db:migrate```
34 38 
 6. Create the initial config and admin user: ```heroku run rake bootstrap:all```
35 39
40 
+## Env Variables
41 
+
42 
+```yml
43 
+	AWS_ACCESS_KEY_ID:
44 
+	AWS_SECRET_ACCESS_KEY:
45 
+	AWS_S3_BUCKET:
46 
+	HEROKU_APP_URL:
47 
+	MANDRILL_USERNAME:
48 
+	MANDRILL_KEY:
49 
+	DOMAIN_NAME:
50 
+	SERVER_EMAIL:
51 
+	DEVISE_SECRET_KEY:
52 
+	SECRET_KEY_BASE:
53 
+	MAILCHIMP_KEY:
54 
+	MAILCHIMP_LIST_ID:
55 
+```
56 
+
36 57 
 ## Todo's
37 58
38 
-* Google Analytics
39 59 
 * Log
40 60 
 * Background processing (redis)
41 61 
 * Search System
 
@@ -51,22 +71,14 @@ A template for creating rails websites that includes the following:
51 71 
 * Store
52 72 
 * Inventory
53 73 
 * Module Controller
54 
-* Newsletter signup
55 74
56 75 
 ## BUGS
57 76
58 
-* Delete user account does not work
59 
-* Wrong redirect after user account deletion
60 
-* edit user page bugs (password)
61 
-* show file page layout
62 77 
 * page titles!
63 78
64 79 
 ## Example Websites
65 80
66 
-- [Velvet Design](http://www.velvetdesign.com.br) (Under Development)
67 
-- [jamesperet.com v2](http://jamesperet.com) (Under Development)
68 
-- [GoldTone](http://goldtone.com) (Under Development)
69 
-- [benjaminperet](http://benjaminperet.com) (Under Development)
70 
-- [High Effects](http://higheffects.com.br) (Under Development)
81 
+- [Rails Website Template Example](http://rails-website-template.herokuapp.com/)
82 
+- [Velvet Design](http://www.velvetdesign.com.br)
71 83
72 84